docs: pin the CI badge to main - #8
Merged
Merged
Conversation
Without `?branch=main` the badge renders the most recent run of the workflow on ANY branch, so a single failing pull-request run turns the README red for everyone reading the repository page while main is green. Pin it to the branch whose health the badge is meant to report.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The README's CI badge had no
?branch=parameter, so it renders the most recent run ofci.ymlon any branch. One failing pull-request run turns the badge red on the public repository page even whilemainis green, which is the opposite of what a status badge is for.Pinned to
?branch=main, matching how kettle already does it.No behaviour change; the badge is green today either way. This is about what it reports tomorrow.